Document api usage #32
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…se/backup endpoint; document authorization token usage
6 tasks
Member
|
Thanks! |
Member
|
By the way, looks like /api/v3 endpoint is mentioned in Securing backup endpoint section of README. However, I think it's better to use /api/v3 endpoint in any cases. We may want to get rid of the redirection from /database/backup and the explanation in README. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In testing this, I noticed that I was not getting this behavior from the api:
I got a
200 Successand a backup file was generated, but no HTTP response body was included with a file name.Is this a documentation defect (should the comment about the file name being returned be removed), or is it a bug (a file name should be returned, but isn't)?